home *** CD-ROM | disk | FTP | other *** search
/ Libris Britannia 4 / science library(b).zip / science library(b) / COMMUNIC / COMMUTIL / 2258.ZIP / EZATYP35.ZIP / EAZATYP3.DOC next >
Text File  |  1990-04-23  |  10KB  |  240 lines
  1.  
  2.                                EAZATYP3.EXE V3.56
  3.                                ------------------
  4.          TYPEs Files to screen which contain EaziLink pseudo-ANSI codes
  5.          --------------------------------------------------------------
  6.  
  7.      23rd April 1990
  8.  
  9.      Disclaimer
  10.      ----------
  11.  
  12.      This program is being put  into  the  Public  Domain and may be freely
  13.      distributed  on  the  understanding  that  no  responsibility  can  be
  14.      accepted for any problems arising  from  its  use.  To the best of our
  15.      knowledge, it is 'Bug free' and serves its intended purpose.
  16.  
  17.      No charge, other than a nominal charge for duplication and postage may
  18.      be made for it and it should only  be supplied as a single ARC, ZIP or
  19.      PAK file called EAZATYP3.ARC, EAZATYP3.ZIP or EAZATYP3.PAK, containing
  20.      the EAZATYP3.EXE, EAZATYP3.DOC and TEXTFILE.BAT files.
  21.  
  22.      Included files
  23.      --------------
  24.  
  25.      EAZATYP3.EXE  - The program file.
  26.      EAZATYP3.DOC  - This documentation.
  27.      TEXTFILE.BAT  - An example of a simple batch file.
  28.  
  29.  
  30.      NOTE FOR USERS OF EARLIER VERSIONS
  31.      ----------------------------------
  32.  
  33.      EazATyp3 now makes use of the COLOUR.HST file to determine the colours
  34.      of the 'More Y/N' and  'Press  ]Return]..' messages. This has resulted
  35.      in the need to provide the Host  Main  Path to the program as an extra
  36.      command line parameter. See 'Using EazAType3' below.
  37.  
  38.  
  39.      Overview
  40.      --------
  41.  
  42.      EazATyp3 converts the output  from  files  containing EaziLink pseudo-
  43.      ANSI codes into true ANSI code output.  There are two main reasons why
  44.      you might want to do this.
  45.  
  46.      1. For use as an EaziLink Door (type  2)  or in a batch file being run
  47.         from a type 2 Door  program.  A  sample  batch  file  for use as an
  48.         EaziLink Host mode type 2  Door  program  is  included to give some
  49.         idea of possible uses.
  50.  
  51.         There is one big advantage to  using EazATyp3 instead of the normal
  52.         TYPE command in a door batch file. Because the emulation being used
  53.         by the caller may be passed  to  the  batch file, it is possible to
  54.         use the same file to display  the  contents in either ANSI or plain
  55.         text form, whereas using TYPE you  would  need to have both an ANSI
  56.         and a plain text file.
  57.  
  58.         Another advantage is that the display pauses after every screenfull
  59.         and at the end.
  60.  
  61.      2. To convert a file containing EaziLink pseudo-ANSI codes into a file
  62.         containing true ANSI codes.
  63.  
  64.  
  65.      Using EAZATYP3
  66.      --------------
  67.  
  68.      EazATyp3 may be used from  the  DOS  command prompt, from within batch
  69.      files being used as a type 2  Door,  or  as  a door program in its own
  70.      right.
  71.  
  72.      Syntax:-
  73.  
  74.          EAZATYP3 <filepathname> <hostmainpath> (AY|N) (CY|N)
  75.  
  76.      <filepathname> is the name of the file to be output and is required. A
  77.      full path and drive may be included.
  78.  
  79.      <hostmainpath> is the full path to the Host Main Directory.
  80.  
  81.      AY|N  is optional and determines whether  the file is output with ANSI
  82.      codes, or as plain text. The '|'  indicates that either 'Y' or 'N' may
  83.      be specified and should not be  included  in the command. The default,
  84.      if omitted, is for output to be plain text.
  85.  
  86.      CY|N  is optional and determines whether the program copyright message
  87.      is displayed at the start. The  '|'  indicates  that either 'Y' or 'N'
  88.      may be specified  and  should  not  be  included  in  the command. The
  89.      default is for the message to be displayed.
  90.  
  91.      Examples:
  92.  
  93.      EAZATYP3 EXAMPLE.TXT C:\EAZIHOST        Output will be as plain text.
  94.  
  95.      EAZATYP3 EXAMPLE.TXT C:\EAZIHOST AY     Output will include ANSI codes.
  96.  
  97.      EAZATYP3 EXAMPLE.DOC C:\EAZIHOST CN     The copyright  message  will be
  98.                                              suppressed and  output  will be
  99.                                              as plain text.
  100.  
  101.      EAZATYP3 EXAMPLE.TXT C:\EAZIHOST AY CN  The copyright  message  will be
  102.                                              suppressed  and   output   will
  103.                                              include ANSI codes.
  104.  
  105.  
  106.      Installing as an EaziLink Door program
  107.      --------------------------------------
  108.  
  109.      The DOORS.HST file  should  be  edited  to  include  a  line  with the
  110.      following entries:-
  111.  
  112.      <validation>;Y;2;<descrip>;<progpathname> <hostmainpath> A%ansi
  113.  
  114.      <validation> is the Minimum  Validation  level  required for access to
  115.      the door.
  116.  
  117.      'Y' and '2' specify  that  'recovery'  is  required  and  that it is a
  118.      'doors type 2' program respectively.
  119.  
  120.      <descrip> is the description to be displayed in the Doors Menu.
  121.  
  122.      <progpathname> is the full pathname for the EAZATYP3.EXE program if it
  123.      is not in a directory specified in  the PATH command in CONFIG.SYS. If
  124.      the directory is in the PATH, then only the program name is necessary.
  125.      This is required in order  that  EazAtyp3  can use the correct display
  126.      colours and write errors to the SYSTEM.ERR file.
  127.  
  128.      <hostmainpath> is the full path to the Host Main Directory.
  129.  
  130.      '%ansi' is an EaziLink variable and  must  be preceded with the letter
  131.      'A', not separated  by  any  spaces.  This  determines  which terminal
  132.      emulation mode is used by EazATyp3.
  133.  
  134.      Optionally 'CN' can be added to the  end  of the line, to suppress the
  135.      copyright message.
  136.  
  137.      Example:-
  138.  
  139.      0;Y;2;View file;C:\EAZILINK\HOSTMAIN\EAZATYP3.EXE TEXTFILE.DOC A%ansi
  140.  
  141.      The above example will  display  the  TEXTFILE.DOC  file, using either
  142.      ANSI codes or  plain  text,  depending  on  the  settings  passed with
  143.      '%ansi'.
  144.  
  145.      Installing as part of a batch file running as an EaziLink Door program
  146.      ----------------------------------------------------------------------
  147.  
  148.      EAZATYP3 may also be used in batch  files to output files. If you have
  149.      a program such as CHOOSE,  or  SandSoft's  INKEY program, which allows
  150.      selection from a menu of options, you  can  create a batch file with a
  151.      menu of files to view.
  152.  
  153.  
  154.      Example, using the supplied batch file described below:-
  155.  
  156.      0;Y;2;View file;C:\EAZILINK\HOSTMAIN\TEXTFILE.BAT A%ansi CN
  157.  
  158.      will run the batch file called  'TEXTFILE.BAT' when the door described
  159.      as 'View file' is selected,  passing  the  current display mode status
  160.      and suppressing the copyright message.
  161.  
  162.  
  163.      A simple batch file
  164.      -------------------
  165.  
  166.      A simple batch file is:-
  167.  
  168.         ECHO OFF
  169.         EAZATYP3 C:\DOC\TEXTFILE.DOC C:\EAZIHOST\HOSTMAIN %1 %2
  170.         ECHO.
  171.         PAUSE
  172.  
  173.      and will display the 'TEXTFILE.DOC' file in the '\DOC' directory.
  174.  
  175.  
  176.      Creating an ANSI file
  177.      ---------------------
  178.  
  179.      EazATyp3 may also be used from the DOS command prompt, to produce true
  180.      ANSI files from an EaziLink pseudo-ANSI file. The syntax to use is:-
  181.  
  182.          EAZATYP3 <pathname> AE
  183.  
  184.      You are then prompted to enter the  name you want the file saved with.
  185.      This may include a path and/or drive letter, if required.
  186.  
  187.  
  188.      Error Messages
  189.      --------------
  190.  
  191.      System errors  resulting  from  incorrect  paths,  filenames  etc  are
  192.      displayed on screen AND written  to  the  SYSTEM.ERR  file in the Host
  193.      Main Directory.
  194.  
  195.      SYSTEM.ERR is created by EaziHost  and  provides  a convenient way for
  196.      the Sysop to check on errors.  If  no  SYSTEM.ERR file is found, a new
  197.      file will be created. The  entry  is  in  the  same  format as used by
  198.      EaziHost and includes the name  of  the  program  from which the error
  199.      originated, the current system date and a description of the error.
  200.  
  201.  
  202.      History
  203.      -------
  204.  
  205.      3.00  09/10/89 - Initial release version.
  206.      3.01  15/10/89 - Minor change to  make  'More'  prompt more line-noise
  207.                       proof. Now only reacts to Y, N, or RETURN.
  208.      3.02  23/10/89 - Added the facility  to  suppress  the  display of the
  209.                       copyright message.
  210.      3.50  08/12/89 - New  beta  version  to  convert  extra  pseudo  codes
  211.                       available with EaziHost V1.
  212.                     - ^I is converted to tab to col 9, 17 etc.
  213.                     - ^P waits for Return to be pressed.
  214.                     - ^Z modified to terminate file,  as in EaziLink V3 and
  215.                       EaziHost V1.
  216.      3.51  19/12/89 - Beta. Minor change to include error mesage requesting
  217.                       notification to the Sysop if invalid parameter passed
  218.                       to program from doorway.
  219.      3.52  01/02/90 - Beta. A  delay  has  been  added  before  the program
  220.                       exits, to solve  a  problem  of  lost characters when
  221.                       used with the latest version of EaziHost.
  222.                     - Minor change made  to  clear  the  'Press [Return]..'
  223.                       message before exit.
  224.                     - System errors are now written to the SYSTEM.ERR file.
  225.      3.55  04/04/90 - First release version for use with EaziLink/EaziHost.
  226.      3.56  23/04/90 - Implemented ^L in Teletype  mode  to  clear screen by
  227.                       sending character 12 decimal, in line with EaziLink.
  228.  
  229.  
  230.      David Foster
  231.      H.L.C. Services
  232.      High Leys
  233.      Crook
  234.      Kendal
  235.      Cumbria
  236.      LA8 8LF
  237.  
  238.                                       END
  239.  
  240.